Class LDAPVirtualListResponse

java.lang.Object
netscape.ldap.LDAPControl
netscape.ldap.controls.LDAPVirtualListResponse
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
LdapVirtualListResponseControl
public class LDAPVirtualListResponse extends LDAPControl
Represents control data for returning paged results from a search.
Version:
1.0 
   VirtualListViewResponse ::= SEQUENCE {
       targetPosition   INTEGER (0 .. maxInt),
       contentCount     INTEGER (0 .. maxInt),
       virtualListViewResult ENUMERATED {
           success                  (0),
           operatonsError           (1),
           timeLimitExceeded        (3),
           adminLimitExceeded       (11),
           insufficientAccessRights (50),
           busy                     (51),
           unwillingToPerform       (53),
           sortControlMissing       (60),
           offsetRangeError         (61),
           other                    (80)
       },
       contextID     OCTET STRING OPTIONAL
  }
See Also:

  • Field Details

    • VIRTUALLISTRESPONSE

      public static final String VIRTUALLISTRESPONSE
      See Also:

    • m_firstPosition

      private int m_firstPosition

    • m_contentCount

      private int m_contentCount

    • m_resultCode

      private int m_resultCode

    • m_context

      private String m_context

  • Constructor Details

    • LDAPVirtualListResponse

      LDAPVirtualListResponse()
      Blank constructor for internal use in LDAPVirtualListResponse.
      See Also:

    • LDAPVirtualListResponse

      public LDAPVirtualListResponse(String oid, boolean critical, byte[] value) throws LDAPException
      Contructs an LDAPVirtualListResponse object.
      Parameters:
      oid - this parameter must be equal to LDAPVirtualListResponse.VIRTUALLISTRESPONSE or an LDAPExceptionis thrown
      critical - true if this control is critical
      value - the value associated with this control
      Throws:
      LDAPException - If oid is not LDAPVirtualListResponse.VIRTUALLISTRESPONSE.
      See Also:

    • LDAPVirtualListResponse

      public LDAPVirtualListResponse(byte[] value)
      Constructs a new LDAPVirtualListResponse object.
      Parameters:
      value - a BER encoded byte array
      See Also:

  • Method Details

    • getContentCount

      public int getContentCount()
      Gets the size of the virtual result set.
      Returns:
      the size of the virtual result set, or -1 if not known.

    • getFirstPosition

      public int getFirstPosition()
      Gets the index of the first entry returned.
      Returns:
      the index of the first entry returned.

    • getResultCode

      public int getResultCode()
      Gets the result code.
      Returns:
      the result code.

    • getContext

      public String getContext()
      Gets the context cookie, if any.
      Returns:
      the result context cookie.

    • parseResponse

      private void parseResponse()
      Parses the control response from a virtual list search. The control should be returned on a previous paged results search, so it contains information on the virtual result set size.

    • parseResponse

      @Deprecated public static LDAPVirtualListResponse parseResponse(LDAPControl[] controls)
      Deprecated.
      LDAPVirtualListResponse controls are now automatically instantiated.
      Returns a control returned on a VLV search.
      Parameters:
      controls - an array of controls that may include a VLV results control
      Returns:
      the control, if any; otherwise null.

    • toString

      public String toString()
      Description copied from class: LDAPControl
      Return a string representation of the control for debugging
      Overrides:
      toString in class LDAPControl
      Returns:
      a string representation of the control.